请求
curl --location 'https://openapi.gs-robot.com/openapi/v3/schedules/plans/simple/create' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data '{
"mapResourceList": [
{
"mapId": "140bbb83-fe48-4282-be25-c48252b9c660",
"mapResourceId": "327594d9-df72-4950-94b2-64e6d02abdfb",
"mapResourceType": "region"
}
],
"planExecuteType": 1,
"planRepeatType": 2,
"planRepeatWeekly": [
1,
3,
5
],
"planStartDate": "2026-08-29",
"planStartTime": "10:30",
"planStopTime": "11:30",
"robotSn": "TEST00-0000-000-B088",
"siteMode": 0,
"taskName": "工作日清洁排班",
"workMode": {
"mode": "wash"
}
}'
版本限制:本接口仅支持 AIO1.6 及以上软件版本。
调用流程
- 调用
/openapi/v3/maps/schedule-resources/list,从maps和workModes中取得机器人实际支持的地图资源与工作模式。 - 调用本接口创建排班。成功响应的
data为排班服务返回的操作结果;本接口不会直接返回planUuid。 - 调用
/openapi/v3/schedules/plans/pre-tasks/day/list查询排班日期,并从data.preTasks[].planUuid取得后续修改、删除或详情查询所需的planUuid。
注意事项
- 写接口的
planExecuteType使用整数:1为定时任务,2为定量任务;查询接口分别返回字符串TIMED_SCHEDULING_TASK、QUANTITATIVE_SCH_TASK。 planRepeatType=0表示单次任务;planRepeatType=2表示每周重复,此时planRepeatWeekly必填且不能为空。星期值0至6分别表示周日至周六。- 时间格式为
HH:mm(24 小时制)。开始日期不能早于当前日期;若为当天,开始时间也必须晚于当前时间。定时任务必须传非空planStopTime;定量任务可以省略,服务按开始时间后 1 分钟处理。显式传入的结束时间必须晚于开始时间,不支持跨午夜。 siteMode=0时不要传siteId;siteMode=1时必须传siteId。mapId使用资源查询响应中的maps[].robotMapUuid。mapResourceList每项只要求mapId、mapResourceId、mapResourceType,不需要另传robotMapUuid。workMode各字段必须参考资源查询接口的实际workModes。若仅凭mode不能唯一匹配配置,请补充subType、type或strength;省略strength时使用默认强度。
输出
{
"code": 0,
"data": {},
"msg": "success"
}